<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>FitNesseHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../apidocs/uk/co/javahelp/maven/plugin/fitnesse/util/FitNesseHelper.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> uk.co.javahelp.maven.plugin.fitnesse.util;
<a class="jxr_linenumber" name="2" href="#2">2</a>   
<a class="jxr_linenumber" name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> java.net.ConnectException;
<a class="jxr_linenumber" name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> java.net.HttpURLConnection;
<a class="jxr_linenumber" name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
<a class="jxr_linenumber" name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="9" href="#9">9</a>   <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a class="jxr_linenumber" name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="12" href="#12">12</a>  
<a class="jxr_linenumber" name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils;
<a class="jxr_linenumber" name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
<a class="jxr_linenumber" name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log;
<a class="jxr_linenumber" name="16" href="#16">16</a>  
<a class="jxr_linenumber" name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> uk.co.javahelp.maven.plugin.fitnesse.main.FitNesseMain;
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> uk.co.javahelp.maven.plugin.fitnesse.mojo.Launch;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> fitnesse.Arguments;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> fitnesse.Shutdown;
<a class="jxr_linenumber" name="21" href="#21">21</a>  
<a class="jxr_linenumber" name="22" href="#22">22</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../uk/co/javahelp/maven/plugin/fitnesse/util/FitNesseHelper.html">FitNesseHelper</a> {
<a class="jxr_linenumber" name="23" href="#23">23</a>  
<a class="jxr_linenumber" name="24" href="#24">24</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ROOT = <span class="jxr_string">"FitNesseRoot"</span>;
<a class="jxr_linenumber" name="25" href="#25">25</a>      
<a class="jxr_linenumber" name="26" href="#26">26</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String UTF8 = <span class="jxr_string">"UTF-8"</span>;
<a class="jxr_linenumber" name="27" href="#27">27</a>      
<a class="jxr_linenumber" name="28" href="#28">28</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> SHUTDOWN_WAIT_MS = 50;
<a class="jxr_linenumber" name="29" href="#29">29</a>      
<a class="jxr_linenumber" name="30" href="#30">30</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Log log;
<a class="jxr_linenumber" name="31" href="#31">31</a>  
<a class="jxr_linenumber" name="32" href="#32">32</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../../uk/co/javahelp/maven/plugin/fitnesse/util/FitNesseHelper.html">FitNesseHelper</a>(<strong class="jxr_keyword">final</strong> Log log) {
<a class="jxr_linenumber" name="33" href="#33">33</a>  		<strong class="jxr_keyword">this</strong>.log = log;
<a class="jxr_linenumber" name="34" href="#34">34</a>  	}
<a class="jxr_linenumber" name="35" href="#35">35</a>      
<a class="jxr_linenumber" name="36" href="#36">36</a>      <strong class="jxr_keyword">public</strong> StringBuilder formatAndAppendClasspathArtifact(<strong class="jxr_keyword">final</strong> StringBuilder wikiFormatClasspath, <strong class="jxr_keyword">final</strong> Artifact artifact) {
<a class="jxr_linenumber" name="37" href="#37">37</a>      	<strong class="jxr_keyword">return</strong> formatAndAppendClasspath(wikiFormatClasspath, artifact.getFile().getPath());
<a class="jxr_linenumber" name="38" href="#38">38</a>  	}
<a class="jxr_linenumber" name="39" href="#39">39</a>      
<a class="jxr_linenumber" name="40" href="#40">40</a>      <strong class="jxr_keyword">public</strong> StringBuilder formatAndAppendClasspath(<strong class="jxr_keyword">final</strong> StringBuilder wikiFormatClasspath, <strong class="jxr_keyword">final</strong> String path) {
<a class="jxr_linenumber" name="41" href="#41">41</a>  		<strong class="jxr_keyword">if</strong>(Utils.whitespaceSituation(path)) {
<a class="jxr_linenumber" name="42" href="#42">42</a>              log.error(Utils.whitespaceWarning(path, <span class="jxr_string">"FitNesse classpath may not function correctly in wiki mode"</span>));
<a class="jxr_linenumber" name="43" href="#43">43</a>  		}
<a class="jxr_linenumber" name="44" href="#44">44</a>         	wikiFormatClasspath.append(<span class="jxr_string">"!path "</span>);
<a class="jxr_linenumber" name="45" href="#45">45</a>         	wikiFormatClasspath.append(path);
<a class="jxr_linenumber" name="46" href="#46">46</a>         	wikiFormatClasspath.append(<span class="jxr_string">"\n"</span>);
<a class="jxr_linenumber" name="47" href="#47">47</a>         	<strong class="jxr_keyword">return</strong> wikiFormatClasspath;
<a class="jxr_linenumber" name="48" href="#48">48</a>      }
<a class="jxr_linenumber" name="49" href="#49">49</a>  
<a class="jxr_linenumber" name="50" href="#50">50</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> launchFitNesseServer(
<a class="jxr_linenumber" name="51" href="#51">51</a>      		<strong class="jxr_keyword">final</strong> String port, <strong class="jxr_keyword">final</strong> String workingDir, <strong class="jxr_keyword">final</strong> String root, <strong class="jxr_keyword">final</strong> String logDir) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="52" href="#52">52</a>          <strong class="jxr_keyword">final</strong> Arguments arguments = <strong class="jxr_keyword">new</strong> Arguments();
<a class="jxr_linenumber" name="53" href="#53">53</a>          arguments.setCommand(<strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="54" href="#54">54</a>          arguments.setInstallOnly(false);
<a class="jxr_linenumber" name="55" href="#55">55</a>          arguments.setOmitUpdates(<strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="56" href="#56">56</a>          arguments.setDaysTillVersionsExpire(<span class="jxr_string">"0"</span>);
<a class="jxr_linenumber" name="57" href="#57">57</a>          arguments.setPort(port);
<a class="jxr_linenumber" name="58" href="#58">58</a>          arguments.setRootPath(workingDir);
<a class="jxr_linenumber" name="59" href="#59">59</a>          arguments.setRootDirectory(root);
<a class="jxr_linenumber" name="60" href="#60">60</a>          <strong class="jxr_keyword">if</strong>(logDir != <strong class="jxr_keyword">null</strong> &amp;&amp; !logDir.trim().equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="61" href="#61">61</a>              arguments.setLogDirectory(logDir);
<a class="jxr_linenumber" name="62" href="#62">62</a>          }
<a class="jxr_linenumber" name="63" href="#63">63</a>          FitNesseMain.launchFitNesse(arguments);
<a class="jxr_linenumber" name="64" href="#64">64</a>      }
<a class="jxr_linenumber" name="65" href="#65">65</a>  
<a class="jxr_linenumber" name="66" href="#66">66</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> shutdownFitNesseServer(<strong class="jxr_keyword">final</strong> String port) {
<a class="jxr_linenumber" name="67" href="#67">67</a>          <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="68" href="#68">68</a>  			Shutdown.main(<strong class="jxr_keyword">new</strong> String[]{<span class="jxr_string">"-p"</span>, port});
<a class="jxr_linenumber" name="69" href="#69">69</a>  			<em class="jxr_comment">// Pause to give it a chance to shutdown</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>      		Thread.sleep(SHUTDOWN_WAIT_MS);
<a class="jxr_linenumber" name="71" href="#71">71</a>  		} <strong class="jxr_keyword">catch</strong> (ConnectException e) {
<a class="jxr_linenumber" name="72" href="#72">72</a>  			<em class="jxr_comment">// If we get this specific exception,</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  			<em class="jxr_comment">// we assume FitNesse is already not running</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>              <strong class="jxr_keyword">this</strong>.log.info(<span class="jxr_string">"FitNesse already not running."</span>);
<a class="jxr_linenumber" name="75" href="#75">75</a>  		} <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="76" href="#76">76</a>             	<strong class="jxr_keyword">this</strong>.log.error(e);
<a class="jxr_linenumber" name="77" href="#77">77</a>  		}
<a class="jxr_linenumber" name="78" href="#78">78</a>      }
<a class="jxr_linenumber" name="79" href="#79">79</a>  
<a class="jxr_linenumber" name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * Note: Through experiment I've found that we can safely send duplicate 'create SymLink' requests - FitNesse isn't bothered</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * But We use a HashSet to eliminate duplicate top-level link names anyway, just to keep the output clean</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     * @throws IOException </em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @see &lt;a href="<a href="http://fitnesse.org/FitNesse.UserGuide.SymbolicLinks" target="alexandria_uri">http://fitnesse.org/FitNesse.UserGuide.SymbolicLinks</a>"&gt;FitNesse SymLink User Guide&lt;/a&gt;</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> createSymLink(<strong class="jxr_keyword">final</strong> File basedir, <strong class="jxr_keyword">final</strong> String testResourceDirectory, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> port,
<a class="jxr_linenumber" name="87" href="#87">87</a>      		<strong class="jxr_keyword">final</strong> Launch... launches) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="88" href="#88">88</a>          <strong class="jxr_keyword">final</strong> Set&lt;String&gt; linkNames = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;();
<a class="jxr_linenumber" name="89" href="#89">89</a>          <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../uk/co/javahelp/maven/plugin/fitnesse/mojo/Launch.html">Launch</a> launch : launches) {
<a class="jxr_linenumber" name="90" href="#90">90</a>          	linkNames.add(calcLinkName(launch));
<a class="jxr_linenumber" name="91" href="#91">91</a>          }
<a class="jxr_linenumber" name="92" href="#92">92</a>          <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">final</strong> String linkName : linkNames) {
<a class="jxr_linenumber" name="93" href="#93">93</a>              createSymLink(basedir, testResourceDirectory, port, linkName);
<a class="jxr_linenumber" name="94" href="#94">94</a>          }
<a class="jxr_linenumber" name="95" href="#95">95</a>      }
<a class="jxr_linenumber" name="96" href="#96">96</a>      
<a class="jxr_linenumber" name="97" href="#97">97</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> createSymLink(<strong class="jxr_keyword">final</strong> File basedir, <strong class="jxr_keyword">final</strong> String testResourceDirectory, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> port,
<a class="jxr_linenumber" name="98" href="#98">98</a>      		<strong class="jxr_keyword">final</strong> String linkName) <strong class="jxr_keyword">throws</strong> IOException {
<a class="jxr_linenumber" name="99" href="#99">99</a>          <strong class="jxr_keyword">final</strong> String linkPath = calcLinkPath(linkName, basedir, testResourceDirectory);
<a class="jxr_linenumber" name="100" href="#100">100</a> 
<a class="jxr_linenumber" name="101" href="#101">101</a>         HttpURLConnection connection = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="102" href="#102">102</a>         <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="103" href="#103">103</a>             <strong class="jxr_keyword">final</strong> String urlPath = 
<a class="jxr_linenumber" name="104" href="#104">104</a>                 String.format(<span class="jxr_string">"/root?responder=symlink&amp;linkName=%s&amp;linkPath=%s&amp;submit=%s"</span>,
<a class="jxr_linenumber" name="105" href="#105">105</a>                 URLEncoder.encode(linkName, UTF8), URLEncoder.encode(linkPath, UTF8), URLEncoder.encode(<span class="jxr_string">"Create/Replace"</span>, UTF8));
<a class="jxr_linenumber" name="106" href="#106">106</a>             <strong class="jxr_keyword">final</strong> URL url = <strong class="jxr_keyword">new</strong> URL(<span class="jxr_string">"http"</span>, <span class="jxr_string">"localhost"</span>, port, urlPath);
<a class="jxr_linenumber" name="107" href="#107">107</a>             <strong class="jxr_keyword">this</strong>.log.info(<span class="jxr_string">"Calling "</span> + url);
<a class="jxr_linenumber" name="108" href="#108">108</a>             connection = (HttpURLConnection) url.openConnection();
<a class="jxr_linenumber" name="109" href="#109">109</a>             connection.setRequestMethod(<span class="jxr_string">"GET"</span>);
<a class="jxr_linenumber" name="110" href="#110">110</a>             connection.connect();
<a class="jxr_linenumber" name="111" href="#111">111</a>             <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> responseCode = connection.getResponseCode();
<a class="jxr_linenumber" name="112" href="#112">112</a>             <strong class="jxr_keyword">this</strong>.log.info(<span class="jxr_string">"Response code: "</span> + responseCode);
<a class="jxr_linenumber" name="113" href="#113">113</a>             <strong class="jxr_keyword">return</strong> responseCode;
<a class="jxr_linenumber" name="114" href="#114">114</a>         } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="115" href="#115">115</a>             <strong class="jxr_keyword">if</strong>(connection != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="116" href="#116">116</a>                 connection.disconnect();
<a class="jxr_linenumber" name="117" href="#117">117</a>             }
<a class="jxr_linenumber" name="118" href="#118">118</a>         }
<a class="jxr_linenumber" name="119" href="#119">119</a>     }
<a class="jxr_linenumber" name="120" href="#120">120</a> 
<a class="jxr_linenumber" name="121" href="#121">121</a>     <strong class="jxr_keyword">private</strong> String calcLinkName(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../uk/co/javahelp/maven/plugin/fitnesse/mojo/Launch.html">Launch</a> launch) {
<a class="jxr_linenumber" name="122" href="#122">122</a>         <strong class="jxr_keyword">final</strong> String linkName = StringUtils.substringBefore(launch.getPageName(), <span class="jxr_string">"."</span>);
<a class="jxr_linenumber" name="123" href="#123">123</a>         <strong class="jxr_keyword">return</strong> linkName;
<a class="jxr_linenumber" name="124" href="#124">124</a>     }
<a class="jxr_linenumber" name="125" href="#125">125</a> 
<a class="jxr_linenumber" name="126" href="#126">126</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">     * We want File.toURL() exactly because it doesn't properly encode URI's,</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">     * otherwise we end up encoding parts of the returned linkPath twice.</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="130" href="#130">130</a>     @SuppressWarnings(<span class="jxr_string">"deprecation"</span>)
<a class="jxr_linenumber" name="131" href="#131">131</a> 	<strong class="jxr_keyword">private</strong> String calcLinkPath(<strong class="jxr_keyword">final</strong> String linkName, <strong class="jxr_keyword">final</strong> File basedir, <strong class="jxr_keyword">final</strong> String testResourceDirectory) <strong class="jxr_keyword">throws</strong> MalformedURLException {
<a class="jxr_linenumber" name="132" href="#132">132</a>         <strong class="jxr_keyword">final</strong> StringBuilder linkPath = <strong class="jxr_keyword">new</strong> StringBuilder(
<a class="jxr_linenumber" name="133" href="#133">133</a>             basedir.toURL().toString()
<a class="jxr_linenumber" name="134" href="#134">134</a>                 .replaceFirst(<span class="jxr_string">"/[A-Z]:"</span>, <span class="jxr_string">""</span>)
<a class="jxr_linenumber" name="135" href="#135">135</a> 				.replaceFirst(<span class="jxr_string">":"</span>, <span class="jxr_string">"://"</span>));
<a class="jxr_linenumber" name="136" href="#136">136</a> 		linkPath.append(testResourceDirectory);
<a class="jxr_linenumber" name="137" href="#137">137</a> 		linkPath.append(<span class="jxr_string">"/"</span>);
<a class="jxr_linenumber" name="138" href="#138">138</a> 		linkPath.append(linkName);
<a class="jxr_linenumber" name="139" href="#139">139</a> 		<strong class="jxr_keyword">return</strong> linkPath.toString();
<a class="jxr_linenumber" name="140" href="#140">140</a>     }
<a class="jxr_linenumber" name="141" href="#141">141</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

